Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use cargo readme in ci #25

Merged
merged 1 commit into from
Jun 23, 2024
Merged

Use cargo readme in ci #25

merged 1 commit into from
Jun 23, 2024

Conversation

usbalbin
Copy link
Owner

@usbalbin usbalbin commented Jun 23, 2024

Testing CI on top of #24

In lack of better words, this seems to fail successfully on the detected diff

Second attempt at checking if README is up to date in CI
@usbalbin usbalbin marked this pull request as ready for review June 23, 2024 21:20
@usbalbin usbalbin merged commit a4ec8f9 into master Jun 23, 2024
16 checks passed
@usbalbin usbalbin changed the title Experiment: Use cargo readme in ci Use cargo readme in ci Jun 23, 2024
@usbalbin usbalbin mentioned this pull request Jun 23, 2024
usbalbin added a commit that referenced this pull request Jun 23, 2024
 ## Breaking
* #21 -feat(breaking): make FromIteratorFixed more generic
  Update `FromIteratorFixed` trait to avoid
  unnameable iterator type as type paramater in the trait

 ## Other changes

* #22 - Some cleaning from additional clippy lints
* #20 - fix: nightly flags and clippy warnings
* #24 - Migrate to use cargo readme
* #25 - Use cargo readme in ci

 ## Thank you
* @Daniel-Aaron-Bloom
* @gwen-lg
usbalbin added a commit that referenced this pull request Jun 23, 2024
 ## Breaking
* #21 -feat(breaking): make FromIteratorFixed more generic
  Update `FromIteratorFixed` trait to avoid
  unnameable iterator type as type paramater in the trait

 ## Other changes

* #22 - Some cleaning from additional clippy lints
* #20 - fix: nightly flags and clippy warnings
* #24 - Migrate to use cargo readme
* #25 - Use cargo readme in ci

 ## Thank you
* @Daniel-Aaron-Bloom
* @gwen-lg
usbalbin added a commit that referenced this pull request Jun 23, 2024
 ## Breaking
* #21 -feat(breaking): make FromIteratorFixed more generic
  Update `FromIteratorFixed` trait to avoid
  unnameable iterator type as type paramater in the trait

 ## Other changes

* #22 - Some cleaning from additional clippy lints
* #20 - fix: nightly flags and clippy warnings
* #24 - Migrate to use cargo readme
* #25 - Use cargo readme in ci

 ## Thank you
* @Daniel-Aaron-Bloom
* @gwen-lg
usbalbin added a commit that referenced this pull request Jun 23, 2024
## Breaking
* #21 -feat(breaking): make FromIteratorFixed more generic
  Update `FromIteratorFixed` trait to avoid
  unnameable iterator type as type paramater in the trait

## Other changes

* #22 - Some cleaning from additional clippy lints
* #20 - fix: nightly flags and clippy warnings
* #24 - Migrate to use cargo readme
* #25 - Use cargo readme in ci

## Thank you
* @Daniel-Aaron-Bloom
* @gwen-lg
@gwen-lg
Copy link
Contributor

gwen-lg commented Jun 24, 2024

@usbalbin did you see my proposal to use :

      - name: Check if readme is up to date
        run: diff README.md <(cargo readme)

instead of

      - name: Generate Readme for comparison
        run: cargo readme > README_.md
      - name: Check if readme is up to date
        run: diff README.md README_.md

?

It's avoid to write a temporary file, and in case of failure, it's permit to have all parts of the check in the error message.

In any case, thank's for the release 👍

@usbalbin
Copy link
Owner Author

Thank you :)

Something like this #26 ?

@gwen-lg
Copy link
Contributor

gwen-lg commented Jun 24, 2024

Thank you :)

Something like this #26 ?

Yes 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants